Add Tor section to User Book and Architecture Book #546
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
A-docs
hinto-janai
approved these changes
Sep 22, 2025
There was a problem hiding this comment.
FYI I am unsure of continuing the architecture book in the current form: #476.
Comment on lines
+29
to
+39
| ## Configuration for cuprated's Tor component | ||
| [tor] | ||
| ## Enable Tor network by specifying how to connect to it. | ||
| ## | ||
| ## When "Daemon" is set, the Tor daemon address to use can be | ||
| ## specified in `tor.daemon.address`. | ||
| ## | ||
| ## Type | String | ||
| ## Valid values | "Arti", "Daemon", "Off" | ||
| ## Examples | "Arti" | ||
| mode = "Off" # <----- Here |
There was a problem hiding this comment.
I think just the key + field is good.
Suggested change
| ## Configuration for cuprated's Tor component | |
| [tor] | |
| ## Enable Tor network by specifying how to connect to it. | |
| ## | |
| ## When "Daemon" is set, the Tor daemon address to use can be | |
| ## specified in `tor.daemon.address`. | |
| ## | |
| ## Type | String | |
| ## Valid values | "Arti", "Daemon", "Off" | |
| ## Examples | "Arti" | |
| mode = "Off" # <----- Here | |
| [tor] | |
| mode = "Off" # <----- Here |
Comment on lines
+68
to
+77
| [p2p.tor_net] | ||
| #... | ||
| ## Enable Tor inbound onion server. | ||
| ## | ||
| ## [...] | ||
| ## | ||
| ## Type | boolean | ||
| ## Valid values | false, true | ||
| ## Examples | false | ||
| inbound_onion = true |
There was a problem hiding this comment.
Suggested change
| [p2p.tor_net] | |
| #... | |
| ## Enable Tor inbound onion server. | |
| ## | |
| ## [...] | |
| ## | |
| ## Type | boolean | |
| ## Valid values | false, true | |
| ## Examples | false | |
| inbound_onion = true | |
| [p2p.tor_net] | |
| inbound_onion = true |
Comment on lines
+80
to
+88
| ### Arti | ||
|
|
||
| If you are using Arti, that's it. `cuprated` will auto-generate a hidden service at startup. | ||
|
|
||
| A few notes: | ||
| - The onion address is generated randomly. | ||
| - The onion address is persistent across reboots. | ||
| - The onion address cannot be changed without deleting the Arti state directory. | ||
|
|
There was a problem hiding this comment.
How do users find the generated arti onion address?
| In the `[tor.daemon]` section, | ||
| The `listening_addr` field must be set to the IP and port on which `cuprated` will listen for connections coming from your Tor daemon. This is the destination of your hidden service. | ||
| ``` | ||
| HiddenServicePort 18083 [127.0.0.1:18090] <-- This part |
There was a problem hiding this comment.
IMO invalid syntax is confusing, how is this?
Suggested change
| HiddenServicePort 18083 [127.0.0.1:18090] <-- This part | |
| # This part | |
| # v | |
| HiddenServicePort 18083 127.0.0.1:18090 |
Comment on lines
+112
to
+114
| HiddenServicePort [18083] 127.0.0.1:18090 | ||
| ^ | ||
| The virtual port |
There was a problem hiding this comment.
Suggested change
| HiddenServicePort [18083] 127.0.0.1:18090 | |
| ^ | |
| The virtual port | |
| HiddenServicePort 18083 127.0.0.1:18090 | |
| # ^ | |
| # The virtual port |
|
|
||
| If everything has been set correctly, your node will start to broadcast its onion address to other Tor peers in order to be reached. | ||
|
|
||
| ## Anonymizing cuprate |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Part of ongoing Tor support development for Cuprate
Follows: #446, #481 and #509
Changelog
This is the first version of the Tor section for the User Book and Architecture Book.
The User Book Tor section treats the following topics:
The Architecture Book Tor section treats the following topics: